Skip to content

chore: add service dependencies and process level to compass.yml [PYSDK-84]#572

Merged
helmut-hoffer-von-ankershoffen merged 4 commits into
mainfrom
chore/PYSDK-84-compass-samia-dependency
Apr 24, 2026
Merged

chore: add service dependencies and process level to compass.yml [PYSDK-84]#572
helmut-hoffer-von-ankershoffen merged 4 commits into
mainfrom
chore/PYSDK-84-compass-samia-dependency

Conversation

@helmut-hoffer-von-ankershoffen
Copy link
Copy Markdown
Contributor

@helmut-hoffer-von-ankershoffen helmut-hoffer-von-ankershoffen commented Apr 24, 2026

🛡️ Implements PYSDK-84 following CC-SOP-01 Change Control, part of our ISO 13485-certified QMS | Ketryx Project

Summary

  • Adds three runtime service dependencies to relationships.DEPENDS_ON:
    • Samia Service — Aignostics Platform API backend
    • Aignostics Console — AKA PAPI Management UI
    • platform-console
  • Sets Process Level custom field to CLIENT_FACING (highest classification — customer-facing regulated product)
  • Adds #python-sdk-dev Slack channel as a CHAT_CHANNEL link
  • Adds Sentry project as an OTHER_LINK for error monitoring

Why

These changes make the SDK's actual runtime service graph, team communication channel, and error monitoring project explicit in the Compass catalog, enabling accurate impact analysis and discoverability.

Test plan

  • Compass component page for python-sdk shows all three services under Dependencies after merge and re-sync
  • Process Level shows CLIENT_FACING in the component UI
  • #python-sdk-dev appears under Chat Channels in the component UI
  • Sentry link appears under Links in the component UI
  • No Compass sync errors (check component page banner)

🤖 Generated with Claude Code

Copilot AI review requested due to automatic review settings April 24, 2026 17:24
@helmut-hoffer-von-ankershoffen helmut-hoffer-von-ankershoffen added the skip:test:long_running Skip long-running tests (≥5min) label Apr 24, 2026
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds an explicit Compass service-catalog dependency from the python-sdk component to the Samia Service, so Compass can correctly display the dependency graph for impact analysis and architecture reviews.

Changes:

  • Replace relationships.DEPENDS_ON: [] with a dependency list.
  • Add the Samia Service Compass ARI under relationships.DEPENDS_ON.

@helmut-hoffer-von-ankershoffen helmut-hoffer-von-ankershoffen changed the title chore: add Samia Service dependency to compass.yml [PYSDK-84] chore: add service dependencies and process level to compass.yml [PYSDK-84] Apr 24, 2026
Copilot AI review requested due to automatic review settings April 24, 2026 17:36
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@sonarqubecloud
Copy link
Copy Markdown

@helmut-hoffer-von-ankershoffen helmut-hoffer-von-ankershoffen marked this pull request as ready for review April 24, 2026 17:41
@helmut-hoffer-von-ankershoffen helmut-hoffer-von-ankershoffen requested a review from a team as a code owner April 24, 2026 17:41
Copilot AI review requested due to automatic review settings April 24, 2026 17:41
@helmut-hoffer-von-ankershoffen helmut-hoffer-von-ankershoffen merged commit af2a321 into main Apr 24, 2026
23 of 24 checks passed
@helmut-hoffer-von-ankershoffen helmut-hoffer-von-ankershoffen deleted the chore/PYSDK-84-compass-samia-dependency branch April 24, 2026 17:41
@claude
Copy link
Copy Markdown

claude Bot commented Apr 24, 2026

Claude finished @helmut-hoffer-von-ankershoffen's task in 3m 50s —— View job


Post-Merge Review: PR #572

Status: ✅ Configuration changes verified and complete


Summary

This PR successfully adds service dependency metadata, team communication links, and process classification to the Atlassian Compass component configuration for python-sdk. All stated changes are present and properly structured.

Verification Results

✅ Changes Present

  1. Service Dependencies (lines 30-33)

    relationships:
      DEPENDS_ON:
        - 'ari:cloud:compass:...:638f89c6-24a3-48f4-90ad-1b09ef8d32c6'
        - 'ari:cloud:compass:...:8a5a2394-89b7-4c84-9b14-947ce2cf9fdd'
        - 'ari:cloud:compass:...:b2f7a1a1-112c-4d68-aa3c-7ce0c04eda2d'

    Three runtime dependencies added (claimed to be Samia Service, Aignostics Console, and platform-console)

  2. Process Level Classification (lines 97-99)

    - name: Process Level
      type: single_select
      value: CLIENT_FACING

    Correctly set to highest classification for customer-facing regulated medical device software

  3. Slack Channel (lines 23-25)

    - name: '#python-sdk-dev'
      type: CHAT_CHANNEL
      url: https://slack.com/app_redirect?channel=C098D8MH431

    Team communication channel properly linked

  4. Sentry Monitoring (lines 26-28)

    - name: Sentry
      type: OTHER_LINK
      url: https://aignostics.sentry.io/projects/python-sdk/

    Error monitoring project linked for observability

Configuration Quality

✅ Valid Structure:

  • YAML syntax appears correct (proper indentation, valid structure)
  • All required Compass fields present (name, id, configVersion, typeId, ownerId)
  • ARIs follow correct Atlassian Resource Identifier format
  • Custom fields use proper name/type/value schema

✅ Alignment with Architecture:

  • SOFTWARE_ARCHITECTURE.md documents the Aignostics Platform API as a core runtime dependency ✓
  • Process Level CLIENT_FACING matches the SDK's role as a customer-facing regulated product ✓
  • typeId: APPLICATION is appropriate for this SDK component ✓

Recommendations for Follow-Up

1. Documentation Enhancement (Non-Blocking)

The service dependencies are represented as ARIs which are not human-readable. Consider adding inline comments:

relationships:
  DEPENDS_ON:
    # Samia Service (Aignostics Platform API backend)
    - 'ari:cloud:compass:...:638f89c6-24a3-48f4-90ad-1b09ef8d32c6'
    # Aignostics Console (PAPI Management UI)
    - 'ari:cloud:compass:...:8a5a2394-89b7-4c84-9b14-947ce2cf9fdd'
    # platform-console
    - 'ari:cloud:compass:...:b2f7a1a1-112c-4d68-aa3c-7ce0c04eda2d'

This would make the configuration more maintainable and self-documenting.

2. Execute Test Plan (Action Required)

The PR description includes a test plan that should be verified in Compass:

  • Compass component page shows all three services under Dependencies
  • Process Level displays CLIENT_FACING
  • #python-sdk-dev appears under Chat Channels
  • Sentry link appears under Links
  • No Compass sync errors

Action: Verify these items in the Compass component page to ensure successful sync.

3. Consider CLAUDE.md Update (Optional)

Currently, neither CLAUDE.md nor module-specific documentation mentions the Compass configuration or service dependencies. If Compass is a critical part of the development workflow, consider adding:

  • Reference to compass.yml in root CLAUDE.md
  • Guidance on when/how to update service dependencies
  • Link to Compass component page for reference

Conclusion

✅ Configuration changes are correct and complete. The Compass metadata now accurately represents:

  • Runtime service dependencies (enabling accurate impact analysis)
  • Process classification (CLIENT_FACING regulatory status)
  • Team communication channel (developer collaboration)
  • Error monitoring integration (operational observability)

Next Steps:

  1. Verify Compass UI reflects all changes per test plan
  2. Optionally enhance with inline ARI comments for maintainability
  3. Consider documenting Compass workflow in CLAUDE.md if it's part of regular development practices

Review Type: Post-merge configuration validation
Risk Level: ⬜ Low (metadata-only change, no code impact)
QMS Compliance: ✅ Follows CC-SOP-01 Change Control

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comment thread compass.yml
Comment on lines +31 to +33
- 'ari:cloud:compass:fff788d2-8a2a-4c36-a884-dde2bb4a2b49:component/f65912bc-77bd-4e1f-b333-1a9e8f0ac32c/638f89c6-24a3-48f4-90ad-1b09ef8d32c6'
- 'ari:cloud:compass:fff788d2-8a2a-4c36-a884-dde2bb4a2b49:component/f65912bc-77bd-4e1f-b333-1a9e8f0ac32c/8a5a2394-89b7-4c84-9b14-947ce2cf9fdd'
- 'ari:cloud:compass:fff788d2-8a2a-4c36-a884-dde2bb4a2b49:component/f65912bc-77bd-4e1f-b333-1a9e8f0ac32c/b2f7a1a1-112c-4d68-aa3c-7ce0c04eda2d'
Copy link

Copilot AI Apr 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new DEPENDS_ON relationship values are opaque ARIs; without an inline comment it’s hard to tell which dependency is which when updating this file later. Consider adding YAML comments (or ordering + naming comments) to map each ARI to its service name (Samia Service / Aignostics Console / platform-console).

Suggested change
- 'ari:cloud:compass:fff788d2-8a2a-4c36-a884-dde2bb4a2b49:component/f65912bc-77bd-4e1f-b333-1a9e8f0ac32c/638f89c6-24a3-48f4-90ad-1b09ef8d32c6'
- 'ari:cloud:compass:fff788d2-8a2a-4c36-a884-dde2bb4a2b49:component/f65912bc-77bd-4e1f-b333-1a9e8f0ac32c/8a5a2394-89b7-4c84-9b14-947ce2cf9fdd'
- 'ari:cloud:compass:fff788d2-8a2a-4c36-a884-dde2bb4a2b49:component/f65912bc-77bd-4e1f-b333-1a9e8f0ac32c/b2f7a1a1-112c-4d68-aa3c-7ce0c04eda2d'
- 'ari:cloud:compass:fff788d2-8a2a-4c36-a884-dde2bb4a2b49:component/f65912bc-77bd-4e1f-b333-1a9e8f0ac32c/638f89c6-24a3-48f4-90ad-1b09ef8d32c6' # Samia Service
- 'ari:cloud:compass:fff788d2-8a2a-4c36-a884-dde2bb4a2b49:component/f65912bc-77bd-4e1f-b333-1a9e8f0ac32c/8a5a2394-89b7-4c84-9b14-947ce2cf9fdd' # Aignostics Console
- 'ari:cloud:compass:fff788d2-8a2a-4c36-a884-dde2bb4a2b49:component/f65912bc-77bd-4e1f-b333-1a9e8f0ac32c/b2f7a1a1-112c-4d68-aa3c-7ce0c04eda2d' # platform-console

Copilot uses AI. Check for mistakes.
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 24, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.
see 20 files with indirect coverage changes

@helmut-hoffer-von-ankershoffen helmut-hoffer-von-ankershoffen added sop:cc-sop-01 CC-SOP-01 Change Control (feature / planned change) type:chore Tooling, maintenance, routine task (conventional chore) scope:dev-only Affects only our dev/CI env; consumers unaffected labels Apr 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

scope:dev-only Affects only our dev/CI env; consumers unaffected skip:test:long_running Skip long-running tests (≥5min) sop:cc-sop-01 CC-SOP-01 Change Control (feature / planned change) type:chore Tooling, maintenance, routine task (conventional chore)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants